<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.13" name="generator"/>
<title>OpenCV: cv::line_descriptor::BinaryDescriptorMatcher Class Reference</title>
<link href="../../opencv.ico" rel="shortcut icon" type="image/x-icon"/>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script src="../../jquery.js" type="text/javascript"></script>
<script src="../../dynsections.js" type="text/javascript"></script>
<script src="../../tutorial-utils.js" type="text/javascript"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script src="../../search/searchdata.js" type="text/javascript"></script>
<script src="../../search/search.js" type="text/javascript"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
//<![CDATA[
MathJax.Hub.Config(
{
  TeX: {
      Macros: {
          matTT: [ "\\[ \\left|\\begin{array}{ccc} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{array}\\right| \\]", 9],
          fork: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ \\end{array} \\right.", 4],
          forkthree: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ \\end{array} \\right.", 6],
          forkfour: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ #7 & \\mbox{#8}\\\\ \\end{array} \\right.", 8],
          vecthree: ["\\begin{bmatrix} #1\\\\ #2\\\\ #3 \\end{bmatrix}", 3],
          vecthreethree: ["\\begin{bmatrix} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{bmatrix}", 9],
          cameramatrix: ["#1 = \\begin{bmatrix} f_x & 0 & c_x\\\\ 0 & f_y & c_y\\\\ 0 & 0 & 1 \\end{bmatrix}", 1],
          distcoeffs: ["(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]]) \\text{ of 4, 5, 8, 12 or 14 elements}"],
          distcoeffsfisheye: ["(k_1, k_2, k_3, k_4)"],
          hdotsfor: ["\\dots", 1],
          mathbbm: ["\\mathbb{#1}", 1],
          bordermatrix: ["\\matrix{#1}", 1]
      }
  }
}
);
//]]>
</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js" type="text/javascript"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css"/>
<link href="../../stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<!--#include virtual="/google-search.html"-->
<table cellpadding="0" cellspacing="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="../../opencv-logo-small.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">OpenCV
    <span id="projectnumber">4.5.2</span>
   </div>
   <div id="projectbrief">Open Source Computer Vision</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script src="../../menudata.js" type="text/javascript"></script>
<script src="../../menu.js" type="text/javascript"></script>
<script type="text/javascript">
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
  <ul>
<li class="navelem"><a class="el" href="../../d2/d75/namespacecv.html">cv</a></li><li class="navelem"><a class="el" href="../../d2/d51/namespacecv_1_1line__descriptor.html">line_descriptor</a></li><li class="navelem"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html">BinaryDescriptorMatcher</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="../../d6/d7b/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">cv::line_descriptor::BinaryDescriptorMatcher Class Reference<div class="ingroups"><a class="el" href="../../dc/ddd/group__line__descriptor.html">Binary descriptors for lines extracted from an image</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<p>furnishes all functionalities for querying a dataset provided by user or internal to class (that user must, anyway, populate) on the model of <a class="el" href="../../d8/d9b/group__features2d__match.html">Descriptor Matchers</a>  
 <a href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#details">More...</a></p>
<p><code>#include &lt;opencv2/line_descriptor/descriptor.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cv::line_descriptor::BinaryDescriptorMatcher:</div>
<div class="dyncontent">
 <div class="center">
  <img alt="" src="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.png" usemap="#cv::line_5Fdescriptor::BinaryDescriptorMatcher_map"/>
  <map id="cv::line_5Fdescriptor::BinaryDescriptorMatcher_map" name="cv::line_5Fdescriptor::BinaryDescriptorMatcher_map">
<area alt="cv::Algorithm" coords="0,0,265,24" href="../../d3/d46/classcv_1_1Algorithm.html" shape="rect" title="This is a base class for all more or less complex algorithms in OpenCV. "/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad7ffa9899a651aaa9babb982bc25f91d"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#ad7ffa9899a651aaa9babb982bc25f91d">BinaryDescriptorMatcher</a> ()</td></tr>
<tr class="memdesc:ad7ffa9899a651aaa9babb982bc25f91d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor.  <a href="#ad7ffa9899a651aaa9babb982bc25f91d">More...</a><br/></td></tr>
<tr class="separator:ad7ffa9899a651aaa9babb982bc25f91d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a846e51382a501be000277ed5fb557535"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#a846e51382a501be000277ed5fb557535">~BinaryDescriptorMatcher</a> ()</td></tr>
<tr class="separator:a846e51382a501be000277ed5fb557535"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36d4530927b9f0255d475b0b2d6c1b7b"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#a36d4530927b9f0255d475b0b2d6c1b7b">add</a> (const std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt; &amp;descriptors)</td></tr>
<tr class="memdesc:a36d4530927b9f0255d475b0b2d6c1b7b"><td class="mdescLeft"> </td><td class="mdescRight">Store locally new descriptors to be inserted in dataset, without updating dataset.  <a href="#a36d4530927b9f0255d475b0b2d6c1b7b">More...</a><br/></td></tr>
<tr class="separator:a36d4530927b9f0255d475b0b2d6c1b7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ce738fed1ec74e2c73c698aac632d96"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#a6ce738fed1ec74e2c73c698aac632d96">clear</a> () <a class="el" href="../../db/de0/group__core__utils.html#ga4d89d63e402ef9ddc48e18e21180fe4a">CV_OVERRIDE</a></td></tr>
<tr class="memdesc:a6ce738fed1ec74e2c73c698aac632d96"><td class="mdescLeft"> </td><td class="mdescRight">Clear dataset and internal data.  <a href="#a6ce738fed1ec74e2c73c698aac632d96">More...</a><br/></td></tr>
<tr class="separator:a6ce738fed1ec74e2c73c698aac632d96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af860050bf3ba0ffa5f31d62c9da2e962"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#af860050bf3ba0ffa5f31d62c9da2e962">knnMatch</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;queryDescriptors, const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;trainDescriptors, std::vector&lt; std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &gt; &amp;matches, int k, const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;mask=<a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a>(), bool compactResult=false) const</td></tr>
<tr class="memdesc:af860050bf3ba0ffa5f31d62c9da2e962"><td class="mdescLeft"> </td><td class="mdescRight">For every input query descriptor, retrieve the best <em>k</em> matching ones from a dataset provided from user or from the one internal to class.  <a href="#af860050bf3ba0ffa5f31d62c9da2e962">More...</a><br/></td></tr>
<tr class="separator:af860050bf3ba0ffa5f31d62c9da2e962"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac14f872d44000c75a6d3bb6aaf48e85a"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#ac14f872d44000c75a6d3bb6aaf48e85a">knnMatch</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;queryDescriptors, std::vector&lt; std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &gt; &amp;matches, int k, const std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt; &amp;masks=std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt;(), bool compactResult=false)</td></tr>
<tr class="separator:ac14f872d44000c75a6d3bb6aaf48e85a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72ab280d507ccb95240300ecd0b00fc0"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#a72ab280d507ccb95240300ecd0b00fc0">match</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;queryDescriptors, const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;trainDescriptors, std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &amp;matches, const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;mask=<a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a>()) const</td></tr>
<tr class="memdesc:a72ab280d507ccb95240300ecd0b00fc0"><td class="mdescLeft"> </td><td class="mdescRight">For every input query descriptor, retrieve the best matching one from a dataset provided from user or from the one internal to class.  <a href="#a72ab280d507ccb95240300ecd0b00fc0">More...</a><br/></td></tr>
<tr class="separator:a72ab280d507ccb95240300ecd0b00fc0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f353796fee66fe7e2692a5cce29861d"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#a0f353796fee66fe7e2692a5cce29861d">match</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;queryDescriptors, std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &amp;matches, const std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt; &amp;masks=std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt;())</td></tr>
<tr class="separator:a0f353796fee66fe7e2692a5cce29861d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec6b90477a2e5fc004a2be28e301627d"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#aec6b90477a2e5fc004a2be28e301627d">radiusMatch</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;queryDescriptors, const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;trainDescriptors, std::vector&lt; std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &gt; &amp;matches, float maxDistance, const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;mask=<a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a>(), bool compactResult=false) const</td></tr>
<tr class="memdesc:aec6b90477a2e5fc004a2be28e301627d"><td class="mdescLeft"> </td><td class="mdescRight">For every input query descriptor, retrieve, from a dataset provided from user or from the one internal to class, all the descriptors that are not further than <em>maxDist</em> from input query.  <a href="#aec6b90477a2e5fc004a2be28e301627d">More...</a><br/></td></tr>
<tr class="separator:aec6b90477a2e5fc004a2be28e301627d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a924938f93553828ad78dae6dafb2a825"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#a924938f93553828ad78dae6dafb2a825">radiusMatch</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;queryDescriptors, std::vector&lt; std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &gt; &amp;matches, float maxDistance, const std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt; &amp;masks=std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt;(), bool compactResult=false)</td></tr>
<tr class="separator:a924938f93553828ad78dae6dafb2a825"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79c1d836e7168c43d85b754414047202"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#a79c1d836e7168c43d85b754414047202">train</a> ()</td></tr>
<tr class="memdesc:a79c1d836e7168c43d85b754414047202"><td class="mdescLeft"> </td><td class="mdescRight">Update dataset by inserting into it all descriptors that were stored locally by <em>add</em> function.  <a href="#a79c1d836e7168c43d85b754414047202">More...</a><br/></td></tr>
<tr class="separator:a79c1d836e7168c43d85b754414047202"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classcv_1_1Algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcv_1_1Algorithm')"><img alt="-" src="../../closed.png"/> Public Member Functions inherited from <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html">cv::Algorithm</a></td></tr>
<tr class="memitem:a827c8b2781ed17574805f373e6054ff1 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a827c8b2781ed17574805f373e6054ff1">Algorithm</a> ()</td></tr>
<tr class="separator:a827c8b2781ed17574805f373e6054ff1 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ae826127fa0f1f8d10a24841bd376f8 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a8ae826127fa0f1f8d10a24841bd376f8">~Algorithm</a> ()</td></tr>
<tr class="separator:a8ae826127fa0f1f8d10a24841bd376f8 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6a18f1825475643e94381697d413972 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#ab6a18f1825475643e94381697d413972">empty</a> () const</td></tr>
<tr class="memdesc:ab6a18f1825475643e94381697d413972 inherit pub_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html" title="This is a base class for all more or less complex algorithms in OpenCV. ">Algorithm</a> is empty (e.g. in the very beginning or after unsuccessful read.  <a href="../../d3/d46/classcv_1_1Algorithm.html#ab6a18f1825475643e94381697d413972">More...</a><br/></td></tr>
<tr class="separator:ab6a18f1825475643e94381697d413972 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a286fc82744ccab3d248aca44524266a9 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a286fc82744ccab3d248aca44524266a9">getDefaultName</a> () const</td></tr>
<tr class="separator:a286fc82744ccab3d248aca44524266a9 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef2ad3f4145bd6e8c3664eb1c4b5e1e6 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#aef2ad3f4145bd6e8c3664eb1c4b5e1e6">read</a> (const <a class="el" href="../../de/dd9/classcv_1_1FileNode.html">FileNode</a> &amp;fn)</td></tr>
<tr class="memdesc:aef2ad3f4145bd6e8c3664eb1c4b5e1e6 inherit pub_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Reads algorithm parameters from a file storage.  <a href="../../d3/d46/classcv_1_1Algorithm.html#aef2ad3f4145bd6e8c3664eb1c4b5e1e6">More...</a><br/></td></tr>
<tr class="separator:aef2ad3f4145bd6e8c3664eb1c4b5e1e6 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a880744bc4e3f45711444571df47d67 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a0a880744bc4e3f45711444571df47d67">save</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;filename) const</td></tr>
<tr class="separator:a0a880744bc4e3f45711444571df47d67 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f8ad7b8add515077367fb9949a174d2 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a1f8ad7b8add515077367fb9949a174d2">write</a> (<a class="el" href="../../da/d56/classcv_1_1FileStorage.html">FileStorage</a> &amp;fs) const</td></tr>
<tr class="memdesc:a1f8ad7b8add515077367fb9949a174d2 inherit pub_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Stores algorithm parameters in a file storage.  <a href="../../d3/d46/classcv_1_1Algorithm.html#a1f8ad7b8add515077367fb9949a174d2">More...</a><br/></td></tr>
<tr class="separator:a1f8ad7b8add515077367fb9949a174d2 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a763a62d1b03042eef7d7fc3ac6c87c79 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a763a62d1b03042eef7d7fc3ac6c87c79">write</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../da/d56/classcv_1_1FileStorage.html">FileStorage</a> &gt; &amp;fs, const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;name=<a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a>()) const</td></tr>
<tr class="memdesc:a763a62d1b03042eef7d7fc3ac6c87c79 inherit pub_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.  <a href="../../d3/d46/classcv_1_1Algorithm.html#a763a62d1b03042eef7d7fc3ac6c87c79">More...</a><br/></td></tr>
<tr class="separator:a763a62d1b03042eef7d7fc3ac6c87c79 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:afd10bfe7d4ab8c952599745b088e9af2"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html">BinaryDescriptorMatcher</a> &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html#afd10bfe7d4ab8c952599745b088e9af2">createBinaryDescriptorMatcher</a> ()</td></tr>
<tr class="memdesc:afd10bfe7d4ab8c952599745b088e9af2"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html" title="furnishes all functionalities for querying a dataset provided by user or internal to class (that user...">BinaryDescriptorMatcher</a> object and return a smart pointer to it.  <a href="#afd10bfe7d4ab8c952599745b088e9af2">More...</a><br/></td></tr>
<tr class="separator:afd10bfe7d4ab8c952599745b088e9af2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_static_methods_classcv_1_1Algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classcv_1_1Algorithm')"><img alt="-" src="../../closed.png"/> Static Public Member Functions inherited from <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html">cv::Algorithm</a></td></tr>
<tr class="memitem:a623841c33b58ea9c4847da04607e067b inherit pub_static_methods_classcv_1_1Algorithm"><td class="memTemplParams" colspan="2">template&lt;typename _Tp &gt; </td></tr>
<tr class="memitem:a623841c33b58ea9c4847da04607e067b inherit pub_static_methods_classcv_1_1Algorithm"><td align="right" class="memTemplItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; _Tp &gt; </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a623841c33b58ea9c4847da04607e067b">load</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;filename, const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;objname=<a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a>())</td></tr>
<tr class="memdesc:a623841c33b58ea9c4847da04607e067b inherit pub_static_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Loads algorithm from the file.  <a href="../../d3/d46/classcv_1_1Algorithm.html#a623841c33b58ea9c4847da04607e067b">More...</a><br/></td></tr>
<tr class="separator:a623841c33b58ea9c4847da04607e067b inherit pub_static_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ba305a10d02479c13cf7d169c321547 inherit pub_static_methods_classcv_1_1Algorithm"><td class="memTemplParams" colspan="2">template&lt;typename _Tp &gt; </td></tr>
<tr class="memitem:a3ba305a10d02479c13cf7d169c321547 inherit pub_static_methods_classcv_1_1Algorithm"><td align="right" class="memTemplItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; _Tp &gt; </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a3ba305a10d02479c13cf7d169c321547">loadFromString</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;strModel, const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;objname=<a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a>())</td></tr>
<tr class="memdesc:a3ba305a10d02479c13cf7d169c321547 inherit pub_static_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Loads algorithm from a String.  <a href="../../d3/d46/classcv_1_1Algorithm.html#a3ba305a10d02479c13cf7d169c321547">More...</a><br/></td></tr>
<tr class="separator:a3ba305a10d02479c13cf7d169c321547 inherit pub_static_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8c591bacb34c485f5b7a250c314fc53 inherit pub_static_methods_classcv_1_1Algorithm"><td class="memTemplParams" colspan="2">template&lt;typename _Tp &gt; </td></tr>
<tr class="memitem:ad8c591bacb34c485f5b7a250c314fc53 inherit pub_static_methods_classcv_1_1Algorithm"><td align="right" class="memTemplItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; _Tp &gt; </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#ad8c591bacb34c485f5b7a250c314fc53">read</a> (const <a class="el" href="../../de/dd9/classcv_1_1FileNode.html">FileNode</a> &amp;fn)</td></tr>
<tr class="memdesc:ad8c591bacb34c485f5b7a250c314fc53 inherit pub_static_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Reads algorithm from the file node.  <a href="../../d3/d46/classcv_1_1Algorithm.html#ad8c591bacb34c485f5b7a250c314fc53">More...</a><br/></td></tr>
<tr class="separator:ad8c591bacb34c485f5b7a250c314fc53 inherit pub_static_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classcv_1_1Algorithm"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcv_1_1Algorithm')"><img alt="-" src="../../closed.png"/> Protected Member Functions inherited from <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html">cv::Algorithm</a></td></tr>
<tr class="memitem:a68eeca71617474ad3d4561786f0289d2 inherit pro_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a68eeca71617474ad3d4561786f0289d2">writeFormat</a> (<a class="el" href="../../da/d56/classcv_1_1FileStorage.html">FileStorage</a> &amp;fs) const</td></tr>
<tr class="separator:a68eeca71617474ad3d4561786f0289d2 inherit pro_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>furnishes all functionalities for querying a dataset provided by user or internal to class (that user must, anyway, populate) on the model of <a class="el" href="../../d8/d9b/group__features2d__match.html">Descriptor Matchers</a> </p>
<p>Once descriptors have been extracted from an image (both they represent lines and points), it becomes interesting to be able to match a descriptor with another one extracted from a different image and representing the same line or point, seen from a differente perspective or on a different scale. In reaching such goal, the main headache is designing an efficient search algorithm to associate a query descriptor to one extracted from a dataset. In the following, a matching modality based on <em>Multi-Index Hashing (MiHashing)</em> will be described.</p>
<h2>Multi-Index Hashing </h2>
<p>The theory described in this section is based on <a class="el" href="../../d0/de3/citelist.html#CITEREF_MIH">[188]</a> . Given a dataset populated with binary codes, each code is indexed <em>m</em> times into <em>m</em> different hash tables, according to <em>m</em> substrings it has been divided into. Thus, given a query code, all the entries close to it at least in one substring are returned by search as <em>neighbor candidates</em>. Returned entries are then checked for validity by verifying that their full codes are not distant (in <a class="el" href="../../d3/d59/structcv_1_1Hamming.html">Hamming</a> space) more than <em>r</em> bits from query code. In details, each binary code <b>h</b> composed of <em>b</em> bits is divided into <em>m</em> disjoint substrings \(\mathbf{h}^{(1)}, ..., \mathbf{h}^{(m)}\), each with length \(\lfloor b/m \rfloor\) or \(\lceil b/m \rceil\) bits. Formally, when two codes <b>h</b> and <b>g</b> differ by at the most <em>r</em> bits, in at the least one of their <em>m</em> substrings they differ by at the most \(\lfloor r/m \rfloor\) bits. In particular, when \(||\mathbf{h}-\mathbf{g}||_H \le r\) (where \(||.||_H\) is the <a class="el" href="../../d3/d59/structcv_1_1Hamming.html">Hamming</a> norm), there must exist a substring <em>k</em> (with \(1 \le k \le m\)) such that</p>
<p class="formulaDsp">
\[||\mathbf{h}^{(k)} - \mathbf{g}^{(k)}||_H \le \left\lfloor \frac{r}{m} \right\rfloor .\]
</p>
<p>That means that if <a class="el" href="../../d3/d59/structcv_1_1Hamming.html">Hamming</a> distance between each of the <em>m</em> substring is strictly greater than \(\lfloor r/m \rfloor\), then \(||\mathbf{h}-\mathbf{g}||_H\) must be larger that <em>r</em> and that is a contradiction. If the codes in dataset are divided into <em>m</em> substrings, then <em>m</em> tables will be built. Given a query <b>q</b> with substrings \(\{\mathbf{q}^{(i)}\}^m_{i=1}\), <em>i</em>-th hash table is searched for entries distant at the most \(\lfloor r/m \rfloor\) from \(\mathbf{q}^{(i)}\) and a set of candidates \(\mathcal{N}_i(\mathbf{q})\) is obtained. The union of sets \(\mathcal{N}(\mathbf{q}) = \bigcup_i \mathcal{N}_i(\mathbf{q})\) is a superset of the <em>r</em>-neighbors of <b>q</b>. Then, last step of algorithm is computing the <a class="el" href="../../d3/d59/structcv_1_1Hamming.html">Hamming</a> distance between <b>q</b> and each element in \(\mathcal{N}(\mathbf{q})\), deleting the codes that are distant more that <em>r</em> from <b>q</b>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad7ffa9899a651aaa9babb982bc25f91d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7ffa9899a651aaa9babb982bc25f91d">◆ </a></span>BinaryDescriptorMatcher()</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cv::line_descriptor::BinaryDescriptorMatcher::BinaryDescriptorMatcher </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>&lt;line_descriptor_BinaryDescriptorMatcher object&gt;</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher(</td><td class="paramname"></td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>The <a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html" title="furnishes all functionalities for querying a dataset provided by user or internal to class (that user...">BinaryDescriptorMatcher</a> constructed is able to store and manage 256-bits long entries. </p>
</div>
</div>
<a id="a846e51382a501be000277ed5fb557535"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a846e51382a501be000277ed5fb557535">◆ </a></span>~BinaryDescriptorMatcher()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">cv::line_descriptor::BinaryDescriptorMatcher::~BinaryDescriptorMatcher </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a36d4530927b9f0255d475b0b2d6c1b7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36d4530927b9f0255d475b0b2d6c1b7b">◆ </a></span>add()</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::add </td>
          <td>(</td>
          <td class="paramtype">const std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt; &amp; </td>
          <td class="paramname"><em>descriptors</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Store locally new descriptors to be inserted in dataset, without updating dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">descriptors</td><td>matrices containing descriptors to be inserted into dataset</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Each matrix <em>i</em> in <b>descriptors</b> should contain descriptors relative to lines extracted from i*-th image. </dd></dl>
</div>
</div>
<a id="a6ce738fed1ec74e2c73c698aac632d96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ce738fed1ec74e2c73c698aac632d96">◆ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::clear </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Clear dataset and internal data. </p>
<p>Reimplemented from <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#aec9c965448e4dc851d7cacd3abd84cd1">cv::Algorithm</a>.</p>
</div>
</div>
<a id="afd10bfe7d4ab8c952599745b088e9af2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd10bfe7d4ab8c952599745b088e9af2">◆ </a></span>createBinaryDescriptorMatcher()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt;<a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html">BinaryDescriptorMatcher</a>&gt; cv::line_descriptor::BinaryDescriptorMatcher::createBinaryDescriptorMatcher </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="../../d2/dde/classcv_1_1line__descriptor_1_1BinaryDescriptorMatcher.html" title="furnishes all functionalities for querying a dataset provided by user or internal to class (that user...">BinaryDescriptorMatcher</a> object and return a smart pointer to it. </p>
</div>
</div>
<a id="af860050bf3ba0ffa5f31d62c9da2e962"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af860050bf3ba0ffa5f31d62c9da2e962">◆ </a></span>knnMatch() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::knnMatch </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>queryDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>trainDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &gt; &amp; </td>
          <td class="paramname"><em>matches</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>k</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>mask</em> = <code><a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a>()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool </td>
          <td class="paramname"><em>compactResult</em> = <code>false</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>matches</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher.knnMatch(</td><td class="paramname">queryDescriptors, trainDescriptors, k[, mask[, compactResult]]</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>None</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher.knnMatchQuery(</td><td class="paramname">queryDescriptors, matches, k[, masks[, compactResult]]</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>For every input query descriptor, retrieve the best <em>k</em> matching ones from a dataset provided from user or from the one internal to class. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queryDescriptors</td><td>query descriptors </td></tr>
    <tr><td class="paramname">trainDescriptors</td><td>dataset of descriptors furnished by user </td></tr>
    <tr><td class="paramname">matches</td><td>vector to host retrieved matches </td></tr>
    <tr><td class="paramname">k</td><td>number of the closest descriptors to be returned for every input query </td></tr>
    <tr><td class="paramname">mask</td><td>mask to select which input descriptors must be matched to ones in dataset </td></tr>
    <tr><td class="paramname">compactResult</td><td>flag to obtain a compact result (if true, a vector that doesn't contain any matches for a given query is not inserted in final result) </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<a id="ac14f872d44000c75a6d3bb6aaf48e85a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac14f872d44000c75a6d3bb6aaf48e85a">◆ </a></span>knnMatch() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::knnMatch </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>queryDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &gt; &amp; </td>
          <td class="paramname"><em>matches</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>k</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt; &amp; </td>
          <td class="paramname"><em>masks</em> = <code>std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt;()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool </td>
          <td class="paramname"><em>compactResult</em> = <code>false</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>matches</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher.knnMatch(</td><td class="paramname">queryDescriptors, trainDescriptors, k[, mask[, compactResult]]</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>None</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher.knnMatchQuery(</td><td class="paramname">queryDescriptors, matches, k[, masks[, compactResult]]</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queryDescriptors</td><td>query descriptors </td></tr>
    <tr><td class="paramname">matches</td><td>vector to host retrieved matches </td></tr>
    <tr><td class="paramname">k</td><td>number of the closest descriptors to be returned for every input query </td></tr>
    <tr><td class="paramname">masks</td><td>vector of masks to select which input descriptors must be matched to ones in dataset (the <em>i</em>-th mask in vector indicates whether each input query can be matched with descriptors in dataset relative to <em>i</em>-th image) </td></tr>
    <tr><td class="paramname">compactResult</td><td>flag to obtain a compact result (if true, a vector that doesn't contain any matches for a given query is not inserted in final result) </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<a id="a72ab280d507ccb95240300ecd0b00fc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72ab280d507ccb95240300ecd0b00fc0">◆ </a></span>match() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::match </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>queryDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>trainDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &amp; </td>
          <td class="paramname"><em>matches</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>mask</em> = <code><a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a>()</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>matches</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher.match(</td><td class="paramname">queryDescriptors, trainDescriptors[, mask]</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>matches</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher.matchQuery(</td><td class="paramname">queryDescriptors[, masks]</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>For every input query descriptor, retrieve the best matching one from a dataset provided from user or from the one internal to class. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queryDescriptors</td><td>query descriptors </td></tr>
    <tr><td class="paramname">trainDescriptors</td><td>dataset of descriptors furnished by user </td></tr>
    <tr><td class="paramname">matches</td><td>vector to host retrieved matches </td></tr>
    <tr><td class="paramname">mask</td><td>mask to select which input descriptors must be matched to one in dataset </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<a id="a0f353796fee66fe7e2692a5cce29861d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f353796fee66fe7e2692a5cce29861d">◆ </a></span>match() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::match </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>queryDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &amp; </td>
          <td class="paramname"><em>matches</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt; &amp; </td>
          <td class="paramname"><em>masks</em> = <code>std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt;()</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>matches</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher.match(</td><td class="paramname">queryDescriptors, trainDescriptors[, mask]</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>matches</td><td>=</td><td>cv.line_descriptor_BinaryDescriptorMatcher.matchQuery(</td><td class="paramname">queryDescriptors[, masks]</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queryDescriptors</td><td>query descriptors </td></tr>
    <tr><td class="paramname">matches</td><td>vector to host retrieved matches </td></tr>
    <tr><td class="paramname">masks</td><td>vector of masks to select which input descriptors must be matched to one in dataset (the <em>i</em>-th mask in vector indicates whether each input query can be matched with descriptors in dataset relative to <em>i</em>-th image) </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<a id="aec6b90477a2e5fc004a2be28e301627d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec6b90477a2e5fc004a2be28e301627d">◆ </a></span>radiusMatch() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::radiusMatch </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>queryDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>trainDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &gt; &amp; </td>
          <td class="paramname"><em>matches</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float </td>
          <td class="paramname"><em>maxDistance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>mask</em> = <code><a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a>()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool </td>
          <td class="paramname"><em>compactResult</em> = <code>false</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>For every input query descriptor, retrieve, from a dataset provided from user or from the one internal to class, all the descriptors that are not further than <em>maxDist</em> from input query. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queryDescriptors</td><td>query descriptors </td></tr>
    <tr><td class="paramname">trainDescriptors</td><td>dataset of descriptors furnished by user </td></tr>
    <tr><td class="paramname">matches</td><td>vector to host retrieved matches </td></tr>
    <tr><td class="paramname">maxDistance</td><td>search radius </td></tr>
    <tr><td class="paramname">mask</td><td>mask to select which input descriptors must be matched to ones in dataset </td></tr>
    <tr><td class="paramname">compactResult</td><td>flag to obtain a compact result (if true, a vector that doesn't contain any matches for a given query is not inserted in final result) </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<a id="a924938f93553828ad78dae6dafb2a825"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a924938f93553828ad78dae6dafb2a825">◆ </a></span>radiusMatch() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::radiusMatch </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>queryDescriptors</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; std::vector&lt; <a class="el" href="../../d4/de0/classcv_1_1DMatch.html">DMatch</a> &gt; &gt; &amp; </td>
          <td class="paramname"><em>matches</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float </td>
          <td class="paramname"><em>maxDistance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt; &amp; </td>
          <td class="paramname"><em>masks</em> = <code>std::vector&lt; <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &gt;()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool </td>
          <td class="paramname"><em>compactResult</em> = <code>false</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queryDescriptors</td><td>query descriptors </td></tr>
    <tr><td class="paramname">matches</td><td>vector to host retrieved matches </td></tr>
    <tr><td class="paramname">maxDistance</td><td>search radius </td></tr>
    <tr><td class="paramname">masks</td><td>vector of masks to select which input descriptors must be matched to ones in dataset (the <em>i</em>-th mask in vector indicates whether each input query can be matched with descriptors in dataset relative to <em>i</em>-th image) </td></tr>
    <tr><td class="paramname">compactResult</td><td>flag to obtain a compact result (if true, a vector that doesn't contain any matches for a given query is not inserted in final result) </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<a id="a79c1d836e7168c43d85b754414047202"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79c1d836e7168c43d85b754414047202">◆ </a></span>train()</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::line_descriptor::BinaryDescriptorMatcher::train </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Update dataset by inserting into it all descriptors that were stored locally by <em>add</em> function. </p>
<dl class="section note"><dt>Note</dt><dd>Every time this function is invoked, current dataset is deleted and locally stored descriptors are inserted into dataset. The locally stored copy of just inserted descriptors is then removed. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>opencv2/line_descriptor/<a class="el" href="../../db/d82/line__descriptor_2include_2opencv2_2line__descriptor_2descriptor_8hpp.html">descriptor.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 2 2021 11:36:48 for OpenCV by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="../../doxygen.png"/>
</a> 1.8.13
</small></address>
<script type="text/javascript">
//<![CDATA[
addTutorialsButtons();
//]]>
</script>
</body>
</html>
